Skip to content

NGF: Add supported images to tech specs and guidance around WAF#1948

Merged
ciarams87 merged 5 commits into
mainfrom
docs/ngf-image-tables
May 19, 2026
Merged

NGF: Add supported images to tech specs and guidance around WAF#1948
ciarams87 merged 5 commits into
mainfrom
docs/ngf-image-tables

Conversation

@ciarams87
Copy link
Copy Markdown
Contributor

@ciarams87 ciarams87 commented May 13, 2026

Proposed changes

This change enhances the NGF technical specifications to include tables of the images provided through our repositories, and adds references to different sections where appropriate linking back to this section.

It also adds a new tab to the Helm installation docs outlining how to install WAF for all Gateways.

This change also adds a section to the WAF configuration guide outlining how the WAF sidecar containers can be optionally customised with different images and other infrastructure settings.

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@ciarams87 ciarams87 requested a review from a team as a code owner May 13, 2026 09:26
@ciarams87 ciarams87 requested a review from a team May 13, 2026 09:26
@github-actions github-actions Bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels May 13, 2026
@github-actions
Copy link
Copy Markdown

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/1948/

@sjberman
Copy link
Copy Markdown
Contributor

We still need to update the WAF getting started guide to say that NGF needs to be installed with the nginx image set to nginx-plus-f5waf. Otherwise, isn't the regular NGINX Plus image going to be used if following the installation step in the prerequisites?

Comment thread content/ngf/overview/technical-specifications.md Outdated
Comment thread content/ngf/overview/technical-specifications.md Outdated
Comment thread content/ngf/overview/technical-specifications.md Outdated
Comment thread content/ngf/waf-integration/configuration.md Outdated
@ciarams87
Copy link
Copy Markdown
Contributor Author

ciarams87 commented May 18, 2026

We still need to update the WAF getting started guide to say that NGF needs to be installed with the nginx image set to nginx-plus-f5waf. Otherwise, isn't the regular NGINX Plus image going to be used if following the installation step in the prerequisites?

@sjberman Our installation docs don't specify the image to use for plus. If the image is not specified, then the WAF one will be used by default if WAF is enabled but no bespoke image was specified

@sjberman
Copy link
Copy Markdown
Contributor

Our installation docs don't specify the image to use for plus. If the image is not specified, then the WAF one will be used by default if WAF is enabled but no bespoke image was specified

@ciarams87 I see --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus in the plus installation command in the docs. Which will set it in the NginxProxy resource on installation, so I don't think that default value in the code gets used.

@ciarams87
Copy link
Copy Markdown
Contributor Author

Our installation docs don't specify the image to use for plus. If the image is not specified, then the WAF one will be used by default if WAF is enabled but no bespoke image was specified

@ciarams87 I see --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus in the plus installation command in the docs. Which will set it in the NginxProxy resource on installation, so I don't think that default value in the code gets used.

@sjberman I forgot to toggle to the plus command in the installation docs so I missed it 🤦🏼‍♀️ Yeah I'll explain this in the waf docs so

Comment thread content/ngf/waf-integration/get-started.md Outdated
@ciarams87 ciarams87 requested review from salonichf5 and sjberman May 19, 2026 11:31
@ciarams87 ciarams87 changed the title NGF: Add supported images to tech specs and guidance around WAF containers NGF: Add supported images to tech specs and guidance around WAF May 19, 2026
@ciarams87 ciarams87 enabled auto-merge (squash) May 19, 2026 14:08
@ciarams87 ciarams87 merged commit 8c7d737 into main May 19, 2026
7 checks passed
@ciarams87 ciarams87 deleted the docs/ngf-image-tables branch May 19, 2026 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants